CloudSerialPort is the serial port on a Cloud device. More...
Inheritance diagram for CloudSerialPort:
Public Member Functions | |
| void | setLmiType (LmiType) |
| Sets the LMI type for this port. More... | |
| LmiType | getLmiType () |
| Returns the LMI type for this port. More... | |
| bool | addSubLink (string, int) |
| Adds a sublink with the specified name and DLCI number to this port. More... | |
| bool | removeSubLink (string) |
| Removes the sublink with the specified name from this port. More... | |
| int | getSubLinkCount () |
| Returns the number of sublinks on this port. More... | |
| CloudSubLink | getSubLinkAt (int) |
| Returns the sublink at the specified index. More... | |
| vector< string > | getSubLinksInfo () |
| Get Sublink info in string format (dlci number and sublink name. More... | |
| CloudSubLink | getSubLinkByDlci (int) |
| Returns the sublink associated with a provided dlci. More... | |
 Public Member Functions inherited from Port | |
| string | getName () |
| Returns the name of the port. More... | |
| int | getChannel () |
| Returns the channel of the port. More... | |
| void | setChannel (int) |
| Sets the channel of the port. More... | |
| string | getTerminalTypeShortString () |
| Returns the name of the port shortened, without number. More... | |
| string | getPortNameNumber () |
| Returns the port number. Can have something like 0/0/0, etc. More... | |
| PortType | getType () |
| Returns the type of the port. More... | |
| void | setDescription (string) |
| Sets the description for the port. More... | |
| string | getDescription () |
| Returns the description of the port. More... | |
| void | setPower (bool) |
| Sets the power state for the port. More... | |
| bool | getPower () |
| Returns true if the port is on, false if the port is off. More... | |
| void | powerChanged (bool) |
| This event is emitted when the power state of the port changes. More... | |
| bool | isStraightPins () |
| Returns true if the pins are straight, for ethernet. More... | |
| bool | isAutoCross () |
| Returns true if the port is configured for auto crossover, for ethernet. More... | |
| void | setBandwidth (int) |
| Sets the bandwidth for the port. More... | |
| int | getBandwidth () |
| Returns the bandwidth of the port. More... | |
| void | setBandwidthAutoNegotiate (bool) |
| Enables or disables bandwidth auto negotiation. More... | |
| bool | isBandwidthAutoNegotiate () |
| Returns true if bandwidth auto negotiation is enabled, otherwise false. More... | |
| void | setFullDuplex (bool) |
| Enables or disables full duplex mode. More... | |
| bool | isFullDuplex () |
| Returns true if full duplex mode is enabled, otherwise false. More... | |
| void | setDuplexAutoNegotiate (bool) |
| Enables or disables duplex auto negotiation. More... | |
| bool | isDuplexAutoNegotiate () |
| Returns true if duplex auto negotiation is enabled, otherwise false. More... | |
| void | setMacAddress (mac) |
| Sets the MAC address on the port. More... | |
| mac | getMacAddress () |
| Returns the MAC address set on the port. More... | |
| void | macChanged (mac, mac) |
| This event is emitted when the MAC address on the port changes. More... | |
| mac | getBia () |
| Returns the burned-in address of the port. More... | |
| void | setClockRate (int) |
| Sets the clock rate on the port. More... | |
| int | getClockRate () |
| Returns the clock rate on the port. More... | |
| Link | getLink () |
| Returns the link connected to the port. More... | |
| bool | isProtocolUp () |
| Returns true if the line protocol is up on the port, otherwise false. More... | |
| bool | isPortUp () |
| Returns true if the status is up on the port, otherwise false. More... | |
| Process | getEncapProcess () |
| Returns the encapsulation process. More... | |
| Process | getKeepAliveProcess () |
| Returns the keepalive process. More... | |
| QString | getRemotePortName () |
| Returns the name of the remote port. More... | |
| LightStatus | getLightStatus () |
| Returns the link light status. More... | |
| void | lightStatusChanged (LightStatus) |
| This event is emitted when the link light changes. More... | |
| void | lightBlinked () |
| This event is emitted when the link light blinks. More... | |
| void | portStatusChanged (bool) |
| This event is emitted when the port status changes. More... | |
| void | lineProtocolChanged (bool) |
| This event is emitted when the line protocol status changes. More... | |
| void | packetReceived (string, int) |
| This event is emitted when the port receives a packet. More... | |
| void | packetSent (string, int) |
| This event is emitted when the port sends a packet. More... | |
| void | packetReceivedWithDetails (Signal, int) |
| This event is emitted when the port receives a packet with details. More... | |
| void | packetSentWithDetails (Signal, int) |
| This event is emitted when the port sends a packet with details. More... | |
| int | getHigherProcessCount () |
| Returns the higher process count. More... | |
| HardwareQueue | getHardwareQueue () |
| Returns the hardware queue. More... | |
| QueueProcess | getQosQueue () |
| Returns the qos queue. More... | |
| bool | isEthernetPort () |
| Returns true if it is a ethernet port, false if not. More... | |
| bool | isWirelessPort () |
| Returns true if it is a wireless port, false if not. More... | |
| bool | isPowerOn () |
| Returns true if the power is on, false if not. More... | |
| void | deleteLink () |
| Public Member Functions inherited from Process | |
| Device | getOwnerDevice () |
| Returns the device for this process. More... | |
Detailed Description
CloudSerialPort is the serial port on a Cloud device.
Member Function Documentation
◆ addSubLink()
| bool CloudSerialPort::addSubLink | ( | string | , |
| int | |||
| ) |
Adds a sublink with the specified name and DLCI number to this port.
- Parameters
-
name,the name for this sublink. dlci,the DLCI number for this sublink.
- Returns
- bool, true if successful, otherwise false.
◆ getLmiType()
| LmiType CloudSerialPort::getLmiType | ( | ) |
Returns the LMI type for this port.
- Returns
- enum<LmiType>, the LMI type for this port. LMI types: eLmiAnsi = 0, eLmiCisco = 1, eLmiQ933a = 2
◆ getSubLinkAt()
| CloudSubLink CloudSerialPort::getSubLinkAt | ( | int | ) |
Returns the sublink at the specified index.
- Parameters
-
index,the index of interest.
- Returns
- CloudSubLink, the CloudSubLink object at the specified index.
◆ getSubLinkByDlci()
| CloudSubLink CloudSerialPort::getSubLinkByDlci | ( | int | ) |
Returns the sublink associated with a provided dlci.
- Parameters
-
dlci,the dlci number.
- Returns
- CloudSubLink, the CloudSubLink object associated with the given dlci number
◆ getSubLinkCount()
| int CloudSerialPort::getSubLinkCount | ( | ) |
Returns the number of sublinks on this port.
- Returns
- int, the number of sublinks on this port.
◆ getSubLinksInfo()
| vector< string > CloudSerialPort::getSubLinksInfo | ( | ) |
Get Sublink info in string format (dlci number and sublink name.
- Returns
- vector<string>, a vector of sublink info in string format
◆ removeSubLink()
| bool CloudSerialPort::removeSubLink | ( | string | ) |
Removes the sublink with the specified name from this port.
- Parameters
-
link,the name of the sublink of interest.
- Returns
- bool, true if successful, otherwise false.
◆ setLmiType()
| void CloudSerialPort::setLmiType | ( | LmiType | ) |
Sets the LMI type for this port.
- Parameters
-
lmiType,the LMI type to set for this port. LMI types: eLmiAnsi = 0, eLmiCisco = 1, eLmiQ933a = 2
The documentation for this class was generated from the following file:
